﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////


#pragma once

#include "GcmpModel.h"

namespace gcmp 
{ 
    class IDocument;
    class IModelView;

    /// \brief 八叉树相关的Utility函数集合
    class GCMP_MODEL_EXPORT OctreeManagerUtils
    {
    public:
        /// \brief 更新文档级八叉树管理器的深度与rootOctree的Box半长
        ///        使用建议：
        ///            1.在文档创建后就调用，否则若文档中Grep数量过多，更新会有性能问题
        ///            2.rootOctree的Box半长maxHalfWidth，单位为毫米，内部默认值为500,000mm(500m)，对应项目范围是1km，若项目范围远超1km，可以按需修改
        ///            3.八叉树管理器的深度默认值为8，深度值越小，过滤效果越差；值越大，过滤效果越好，但对空间的划分越细，导致性能下降
        ///
        /// \param pDocument 文档指针
        /// \param maxHalfWidth rootOctree的Box半长值
        /// \param maxDepth 深度值，默认为8
        /// \return 更新成功返回true，否则返回false
        static bool UpdateDocumentOctreeManagerHalfWidthAndDepth(IDocument* pDocument, int maxHalfWidth, int maxDepth = 8);

        /// \brief 更新当前视图八叉树管理器的深度与rootOctree的Box半长
        ///        使用建议：
        ///            1.建议在视图创建后就调用，否则若视图中Grep数量过多，更新会有性能问题
        ///            2.rootOctree的Box半长maxHalfWidth，单位为毫米，内部默认值为500,000mm(500m)，对应项目范围是1km，若项目范围远超1km，可以按需修改
        ///            3.八叉树管理器的深度默认值为8，深度值越小，过滤效果越差；值越大，过滤效果越好，但对空间的划分越细，导致性能下降
        ///
        /// \param pModelView 当前视图指针
        /// \param maxHalfWidth rootOctree的Box半长值
        /// \param maxDepth 深度值，默认为8
        /// \return 更新成功返回true，否则返回false
        static bool UpdateModelViewOctreeManagerHalfWidthAndDepth(IModelView* pModelView, int maxHalfWidth, int maxDepth = 8);
        
    };
}
